Skip to content

🐛 Fetch the documentation URL dynamically#24

Closed
chipytux wants to merge 14 commits intofastapi:mainfrom
chipytux:feat/get_app_docs_url
Closed

🐛 Fetch the documentation URL dynamically#24
chipytux wants to merge 14 commits intofastapi:mainfrom
chipytux:feat/get_app_docs_url

Conversation

@chipytux
Copy link

@chipytux chipytux commented May 13, 2024 •
edited
Loading

Pull Request Description

Title: Fetch docs_url dynamically from FastAPI app

Description:

This pull request introduces a change to the fastapi-cli library that fetches the docs_url value dynamically from the FastAPI application instead of using a hardcoded value.

Implementation Details:

The change involves modifying the _run function to fetch the docs_url value from the FastAPI application using the app.openapi_url attribute. This ensures that the library always uses the URL specified by the application itself.

Testing:

The updated function has been thoroughly tested to ensure it correctly retrieves the docs_url value from the FastAPI application and show the appropriate URL.

 ╭────────── FastAPI CLI - Development mode ───────────╮                        
 │                                                     │                        
 │  Serving at: http://127.0.0.1:9901                  │                        
 │                                                     │                        
 │  API docs: http://127.0.0.1:9901/any-other-path     │                        
 │                                                     │                        
 │  Running in development mode, for production use:   │                        
 │                                                     │                        
 │  fastapi run                                        │                        
 │                                                     │                        
 ╰─────────────────────────────────────────────────────╯

@chipytux chipytux changed the title feat: fetch app docs_url fix: fetch app docs_url May 13, 2024
@chipytux chipytux force-pushed the feat/get_app_docs_url branch from becbe1e to dfec882 Compare May 13, 2024 22:43
mattmess1221
mattmess1221 reviewed May 15, 2024
View reviewed changes
@chipytux chipytux force-pushed the feat/get_app_docs_url branch from dfec882 to fb3ee8e Compare May 15, 2024 17:29
@chipytux
Copy link
Author

chipytux commented May 22, 2024 •
edited
Loading

Do you think this is a good approach @tiangolo ? 🙏🏻

😉 @pedroimpulcetto

@chipytux chipytux changed the title fix: fetch app docs_url feat: fetch app docs_url Jul 25, 2024
@chipytux chipytux changed the title feat: fetch app docs_url feature: fetch app docs_url Aug 15, 2024
@chipytux
Copy link
Author

chipytux commented Aug 15, 2024

@tiangolo I do not have permission to configure a label for the PR. https://github.com/fastapi/fastapi-cli/actions/runs/10408815023/job/28827030912?pr=24

@tobb10001
Copy link

tobb10001 commented Jan 27, 2025

I ran across the same bug today and I can confirm that the provided patch resolves the issue.

@twibster twibster mentioned this pull request Mar 4, 2025
Open
@github-actions
Copy link
Contributor

github-actions bot commented Sep 5, 2025

This pull request has a merge conflict that needs to be resolved.

@github-actions github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Sep 5, 2025
@svlandeg svlandeg added docs Improvements or additions to documentation and removed docs Improvements or additions to documentation labels Sep 5, 2025
@svlandeg svlandeg added the bug Something isn't working label Sep 5, 2025
@svlandeg svlandeg changed the title feature: fetch app docs_url 🐛 Fetch the documentation URL dynamically Sep 5, 2025
@svlandeg svlandeg linked an issue Sep 5, 2025 that may be closed by this pull request
Hard-coded documentation endpoint #162
Open
@YuriiMotov
Copy link
Member

YuriiMotov commented Sep 23, 2025

@chipytux , thank you for your interest and efforts!

This PR needs to be updated to reflect latest changes.
We also need to add some tests (including tests with root_path specified and specifying app path using entrypoint parameter).

Would you like to work on this?

@Infamous003
Copy link

Infamous003 commented Sep 29, 2025

Hi, this sounds interesting. Could you tell me more about what exactly needs to be done?

@pedroimpulcetto
Copy link
Contributor

pedroimpulcetto commented Oct 1, 2025 •
edited
Loading

oh, ok, I'm able to handle these changes since @chipytux isn't aware of it

cc: @YuriiMotov

@YuriiMotov
Copy link
Member

YuriiMotov commented Oct 1, 2025

I meant we need to resolve the merge conflicts (merge main branch into the branch of this PR) and ensure it still works as expected.

The entrypoint option was added recently, we need to make sure it works correctly with these changes.
And, we need to add tests with edge cases like root_path.

@pedroimpulcetto pedroimpulcetto mentioned this pull request Oct 2, 2025
Open
@chipytux
Copy link
Author

chipytux commented Dec 12, 2025

I ended up not keeping up with the notifications for this pull request on GitHub, my apologies. I’m glad @pedroimpulcetto continued working on the solution in PR #221.

I believe this will help some people access the Swagger page more quickly. I will close this pull request since the work will continue in PR #221.

@chipytux chipytux closed this Dec 12, 2025
@pedroimpulcetto
Copy link
Contributor

pedroimpulcetto commented Dec 12, 2025

Thank you @chipytux for the original idea!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@mattmess1221 mattmess1221 mattmess1221 left review comments

@pedroimpulcetto pedroimpulcetto pedroimpulcetto approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

bug Something isn't working conflicts Automatically generated when a PR has a merge conflict

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Hard-coded documentation endpoint

7 participants

@chipytux @tobb10001 @YuriiMotov @Infamous003 @pedroimpulcetto @mattmess1221 @svlandeg